<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvToolsExtSemanticsCounters.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_48b95086e7eb28d79ef283b47c5fa0c6.html">nvtx3</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">nvToolsExtSemanticsCounters.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION &amp; AFFILIATES. All rights reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * Licensed under the Apache License v2.0 with LLVM Exceptions.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * See https://nvidia.github.io/NVTX/LICENSE.txt for license information.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> */</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#if defined(NVTX_AS_SYSTEM_HEADER)</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#if defined(__clang__)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#pragma clang system_header</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#elif defined(__GNUC__) || defined(__NVCOMPILER)</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#pragma GCC system_header</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#elif defined(_MSC_VER)</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#pragma system_header</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &quot;nvToolsExtPayload.h&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#ifndef NVTX_SEMANTIC_ID_COUNTERS_V1</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#define NVTX_SEMANTIC_ID_COUNTERS_V1 5</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">/* Use with the version field of `nvtxSemanticsHeader_t`. */</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#define NVTX_COUNTER_SEMANTIC_VERSION 2</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment">/***  Flags to augment the counter value. ***/</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#define NVTX_COUNTER_FLAGS_NONE  0</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_NORMALIZE  (1 &lt;&lt; 1)</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_LIMIT_MIN  (1 &lt;&lt; 2)</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_LIMIT_MAX  (1 &lt;&lt; 3)</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_LIMITS \</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">    (NVTX_COUNTER_FLAG_LIMIT_MIN | NVTX_COUNTER_FLAG_LIMIT_MAX)</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_VALUETYPE_ABSOLUTE          (1 &lt;&lt; 4)</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">/* Delta to previous sample, tool-defined if no previous sample is available. */</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_VALUETYPE_DELTA             (2 &lt;&lt; 4)</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_VALUETYPE_DELTA_SINCE_START (3 &lt;&lt; 4)</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">/* No interpolation between samples. */</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_INTERPOLATION_POINT         (1 &lt;&lt; 8)</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">/* Piecewise constant interpolation between the current and the last sample. */</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_INTERPOLATION_SINCE_LAST    (2 &lt;&lt; 8)</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">/* Piecewise constant interpolation between the current and the next sample. */</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_INTERPOLATION_UNTIL_NEXT    (3 &lt;&lt; 8)</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">/* Piecewise linear interpolation between samples. */</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#define NVTX_COUNTER_FLAG_INTERPOLATION_LINEAR        (4 &lt;&lt; 8)</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#define NVTX_COUNTER_LIMIT_UNDEFINED 0</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#define NVTX_COUNTER_LIMIT_I64       1</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#define NVTX_COUNTER_LIMIT_U64       2</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#define NVTX_COUNTER_LIMIT_F64       3</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="foldopen" id="foldopen00091" data-start="{" data-end="};">
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="unionnvtx_counter_limit__t.html">   91</a></span><span class="keyword">typedef</span> <span class="keyword">union</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>{</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>    int64_t i64;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>    uint64_t u64;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="keywordtype">double</span> f64;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>} <a class="code hl_union" href="unionnvtx_counter_limit__t.html">nvtxCounterLimit_t</a>;</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span> </div>
<div class="foldopen" id="foldopen00101" data-start="{" data-end="};">
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html">  101</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>nvtxSemanticsCounter_v1</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>{</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#a11f4578f98bf9511ac49621748b26057">  104</a></span>    <span class="keyword">struct </span>nvtxSemanticsHeader_v1 header;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#ae3cbd14c5905b869b24212b85b013963">  110</a></span>    uint64_t <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#ae3cbd14c5905b869b24212b85b013963">flags</a>;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#ab63975716531a02c826e3d60924498e9">  113</a></span>    <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#ab63975716531a02c826e3d60924498e9">unit</a>;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#a8b5740c0116aa8943ba43f9c97e14c64">  116</a></span>    uint64_t <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#a8b5740c0116aa8943ba43f9c97e14c64">unitScaleNumerator</a>;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#a88d60a2c7692ca703a542f3252770f74">  119</a></span>    uint64_t <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#a88d60a2c7692ca703a542f3252770f74">unitScaleDenominator</a>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#a3ff51c92a09bb34e169de38309e01582">  125</a></span>    int64_t <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#a3ff51c92a09bb34e169de38309e01582">limitType</a>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="structnvtx_semantics_counter__t.html#a353d625001638a5d2c7341a013e505f4">  128</a></span>    <a class="code hl_union" href="unionnvtx_counter_limit__t.html">nvtxCounterLimit_t</a> <a class="code hl_variable" href="structnvtx_semantics_counter__t.html#a353d625001638a5d2c7341a013e505f4">min</a>;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>    <a class="code hl_union" href="unionnvtx_counter_limit__t.html">nvtxCounterLimit_t</a> max;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>} <a class="code hl_struct" href="structnvtx_semantics_counter__t.html">nvtxSemanticsCounter_t</a>;</div>
</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="preprocessor">#endif </span><span class="comment">/* NVTX_SEMANTIC_ID_COUNTERS_V1 */</span><span class="preprocessor"></span></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html"><div class="ttname"><a href="structnvtx_semantics_counter__t.html">nvtxSemanticsCounter_t</a></div><div class="ttdoc">Specify additional properties of a counter or counter group.</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00101">nvToolsExtSemanticsCounters.h:102</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_a353d625001638a5d2c7341a013e505f4"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#a353d625001638a5d2c7341a013e505f4">nvtxSemanticsCounter_t::min</a></div><div class="ttdeci">nvtxCounterLimit_t min</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00128">nvToolsExtSemanticsCounters.h:128</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_a3ff51c92a09bb34e169de38309e01582"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#a3ff51c92a09bb34e169de38309e01582">nvtxSemanticsCounter_t::limitType</a></div><div class="ttdeci">int64_t limitType</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00125">nvToolsExtSemanticsCounters.h:125</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_a88d60a2c7692ca703a542f3252770f74"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#a88d60a2c7692ca703a542f3252770f74">nvtxSemanticsCounter_t::unitScaleDenominator</a></div><div class="ttdeci">uint64_t unitScaleDenominator</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00119">nvToolsExtSemanticsCounters.h:119</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_a8b5740c0116aa8943ba43f9c97e14c64"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#a8b5740c0116aa8943ba43f9c97e14c64">nvtxSemanticsCounter_t::unitScaleNumerator</a></div><div class="ttdeci">uint64_t unitScaleNumerator</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00116">nvToolsExtSemanticsCounters.h:116</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_ab63975716531a02c826e3d60924498e9"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#ab63975716531a02c826e3d60924498e9">nvtxSemanticsCounter_t::unit</a></div><div class="ttdeci">const char * unit</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00113">nvToolsExtSemanticsCounters.h:113</a></div></div>
<div class="ttc" id="astructnvtx_semantics_counter__t_html_ae3cbd14c5905b869b24212b85b013963"><div class="ttname"><a href="structnvtx_semantics_counter__t.html#ae3cbd14c5905b869b24212b85b013963">nvtxSemanticsCounter_t::flags</a></div><div class="ttdeci">uint64_t flags</div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00110">nvToolsExtSemanticsCounters.h:110</a></div></div>
<div class="ttc" id="aunionnvtx_counter_limit__t_html"><div class="ttname"><a href="unionnvtx_counter_limit__t.html">nvtxCounterLimit_t</a></div><div class="ttdef"><b>Definition</b> <a href="nv_tools_ext_semantics_counters_8h_source.html#l00091">nvToolsExtSemanticsCounters.h:92</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
